How to Read [Dynamic Endpoint] (Use this for fewer than 50 Fields in v3+) — Zoho CRM Connector for SSIS

Prerequisites

Before we begin, make sure the following prerequisites are met:

  1. SSIS designer installed. Sometimes it is referred as BIDS or SSDT (download it from Microsoft).
  2. Basic knowledge of SSIS package development using Microsoft SQL Server Integration Services.
  3. SSIS PowerPack is installed (if you are new to SSIS PowerPack, then get started!).

Read [Dynamic Endpoint] (Use this for fewer than 50 Fields in v3+) in SSIS

  1. Begin with opening Visual Studio and Create a New Project.

  2. Select Integration Service Project and in new project window set the appropriate name and location for project. And click OK.

    In the new SSIS project screen you will find the following:

    • SSIS ToolBox on left side bar
    • Solution Explorer and Property Window on right bar
    • Control flow, data flow, event Handlers, Package Explorer in tab windows
    • Connection Manager Window in the bottom
    SSIS Project Screen
    Note: If you don't see ZappySys SSIS PowerPack Task or Components in SSIS Toolbox, please refer to this help link.
  3. Now, Drag and Drop SSIS Data Flow Task from SSIS Toolbox. Double click on the Data Flow Task to see Data Flow designer.

    SSIS Data Flow Task - Drag and Drop
  4. From the SSIS toolbox drag and API Source (Predefined Templates) on the data flow designer surface, and double click on it to edit it:

    SSIS API Source (Predefined Templates) - Drag and Drop
  5. Select New Connection to create a new connection:

    API Source - New Connection
  6. Use a preinstalled Zoho CRM Connector from Popular Connector List or press Search Online radio button to download Zoho CRM Connector. Once downloaded simply use it in the configuration:

    Zoho CRM
    Zoho CRM Connector Selection
  7. Now it's time to configure authentication. Firstly, configure authentication settings in Zoho CRM service and then proceed by configuring API Connection Manager. Start by expanding an authentication type:

    Zoho CRM authentication

    OAuth Connection for Zoho CRM API [API reference]

    To register custom App, perform the following steps (Detailed steps found in the help link at the end)
    1. Go to Zoho API Console
    2. Click Add Client link
    3. Select Server-based Applications option
    4. Enter desired client name (Display purpose only)
    5. Enter some URL for Company homepage
    6. For Authorized Redirect URI enter https://zappysys.com/oauth (Or enter your own but we recommend using ZappySys one if possible). This URL must match on Zoho Connector UI.
    7. Click CREATE.
    8. Copy Client ID and Secret and paste on Zoho Connector UI.
    API Connection Manager configuration

    Just perform these simple steps to finish authentication configuration:

    1. Set Authentication Type to OAuth [OAuth]
    2. Optional step. Modify API Base URL if needed (in most cases default will work).
    3. Fill in all the required parameters and set optional parameters if needed.
    4. Press Generate Token button to generate the tokens.
    5. Finally, hit OK button:
    Zoho CRM
    OAuth [OAuth]
    https://www.zohoapis.com/crm/[$Version$]
    Optional Parameters
    ClientId
    ClientSecret
    Permissions ZohoCRM.settings.all ZohoCRM.modules.all ZohoCRM.coql.READ
    AccountUrl https://accounts.zoho.com
    RedirectUrl https://zappysys.com/oauth
    API Version v2
    RetryMode RetryWhenStatusCodeMatch
    RetryStatusCodeList 429
    RetryCountMax 5
    RetryMultiplyWaitTime True
    ZappySys OAuth Connection
  8. Select Read [Dynamic Endpoint] (Use this for fewer than 50 Fields in v3+) endpoint from the dropdown and hit Preview Data:

    API Source - Zoho CRM
    Zoho CRM Connector can be used to integrate Zoho CRM API in your App / BI Tools. You can exchange data on Accounts, Leads, Contacts and many other modules.
    Zoho CRM
    Read [Dynamic Endpoint] (Use this for fewer than 50 Fields in v3+)
    Optional Parameters
    Module [$parent.api_name$]
    Fetch records modified after (local time format: yyyy-MM-ddTHH:mm:ss) 1900-12-31T00:00:00
    Custom View ID
    FieldsMultiSelectAllOnBlank False
    FieldsMultiSelectLimit 0
    Fields (Only for V2 API)
    sort_by
    sort_order
    territory_id
    include_child
    converted
    PagingMode ByUrlParameter
    NextUrlAttributeOrExpr $.info.next_page_token
    NextUrlSuffix page_token=<%nextlink%>
    SSIS API Source - Read from table or endpoint
  9. That's it! We are done! Just in a few clicks we configured the call to Zoho CRM using Zoho CRM Connector.

    You can load the source data into your desired destination using the Upsert Destination , which supports SQL Server, PostgreSQL, and Amazon Redshift. We also offer other destinations such as CSV , Excel , Azure Table , Salesforce , and more . You can check out our SSIS PowerPack Tasks and components for more options. (*loaded in Trash Destination)

    Execute Package - Reading data from Zoho CRM and load into target

More actions supported by Zoho CRM Connector

Learn how to perform other actions directly in SSIS with these how-to guides:

More integrations

All
Data Integration
Database
BI & Reporting
Productivity
Programming Languages
Automation & Scripting
ODBC applications